home *** CD-ROM | disk | FTP | other *** search
/ Aminet 20 / Aminet 20 (1997)(GTI - Schatztruhe)[!][Aug 1997].iso / Aminet / hard / drivr / vbak2091.readme < prev    next >
Text File  |  1997-07-13  |  12KB  |  268 lines
  1. Short:    Makes A2091 work better in A4000. V1.1 (25.6.97)
  2. Author:   Volker Barthelmann, Andreas R. Kleinert
  3. Uploader: Andreas_Kleinert@t-online.de
  4. Type:     hard/drivr
  5.  
  6.  
  7.     vb2091 (vbak2091) V1.1 (25.6.97)
  8.  
  9.     (c) in 1994 by Volker Barthelmann
  10.     modified 1996-97 by Andreas R. Kleinert,
  11.  
  12.     USAGE AT YOUR OWN RISK. NOBODY CAN BE HELD RESPONSIBLE FOR ANY DAMAGES.
  13.  
  14.  
  15. PREFACE
  16.  
  17.     [ Andreas: ] Since I had some problems with the A2091 in my
  18.                  A4000 and saw room for some optimizations in vb2091,
  19.                  I decided to write something like "vbak2091" and
  20.                  contacted Volker to take a look at the resulting
  21.                  source. I've now been testing the current SAS/C compiled
  22.                  version for about 2 months and did not encounter any problems,
  23.                  and decided to do a final release, where Volker did the final
  24.                  adjustments for his VBCC compiler. GCC should work, too.
  25.  
  26.                  Included you find the compiled SAS/C version (vbak2091),
  27.                  the SAS/C, GCC and VBCC-aware source code (vbak2091.c)
  28.                  and the original source code of the last public Aminet
  29.                  release (vb2091.c).
  30.  
  31.                  So you can easily see, what the program is doing.
  32.  
  33.                  Feel free to modify and improve the source code,
  34.                  but tell us before releasing it !
  35.  
  36.                  Neither me nor Volker will take any responsibility
  37.                  for any results out of the usage of this program;
  38.                  neither for any damages nor any loss of data, nor
  39.                  anything else. It's your own risk!
  40.  
  41.                  Enjoy :-)
  42.  
  43.                  Andreas R. Kleinert <Andreas_Kleinert@t-online.de>
  44.  
  45.                  Following is the original documentation, speaking
  46.                  is [ Volker: ]
  47.  
  48. INTRODUCTION
  49.  
  50.     ZorroII boards can only reach the lower 16MB of address space. So DMA
  51.     SCSI controllers must find another way to transfer data to expansion
  52.     RAM. Some of them (especially the A2091) do a very bad job in this
  53.     situation. In an A4000/40 transfer rates may drop to 50KB/s.
  54.     This program patches the (2nd.)scsi.device to use MEMF_24BITDMA
  55.     RAM as a buffer followed (in case of CMD_READ) by CopyMem().
  56.     It was developed with the A4000/A2091 combinbation in mind, but
  57.     should work with other configurations, too (see REQUIREMENTS). Some
  58.     people reported good results with GVP controllers.
  59.  
  60.     There have been some bugfixes, additional options and changes of the
  61.     commandline options since the last public release. So I am afraid all
  62.     users of previous versions will have to read this manual again
  63.     (especially the USAGE section).
  64.  
  65.  
  66. FEATURES
  67.  
  68.     There are already some PD utilities floating around that do a similar
  69.     job. So why may this one be better?
  70.  
  71.     - It patches the device instead of the Read() & Write() DOS-functions,
  72.       giving the following advantages:
  73.  
  74.       o Programs accessing the device directly (e.g. SysInfo, SCSI-Speed
  75.         or tape-handlers) are patched, too.
  76.       o Patching Read() doesn't seem to have any influence on LoadSeg(), so
  77.         those patches don't speedup loading of programs whereas vb2091 does.
  78.       o It is possible to use double-buffering and load into one buffer
  79.         while copying the contents of the other one to fastram. This makes
  80.         higher transfer rates possible. I wasn't able to get more than
  81.         800KB/s with DOS-level-patches, but could get over 1MB/s with
  82.         vb2091.
  83.  
  84.     - Some early A4000s (including mine :-( ) can't do DMA to onboard ram.
  85.       On such A4000s every transfer to/from chipmem will cause the
  86.       computer to hang. vb2091 can be told to redirect those transfers too.
  87.  
  88. WARNING
  89.  
  90.     FIRST: READ THIS ENTIRE FILE BEFORE TRYING OUT vb2091 !!
  91.     (This is meant seriously - I know this is a very badly written manual,
  92.     but it mentions some very important points.)
  93.  
  94.     This program is still beta and I can't give any warranty about anything.
  95.     I have tested it for some time and have not encountered serious
  96.     problems, but had no opportunity to test vb2091 on other configs,
  97.     so there may still be many bugs.
  98.     It seems to work fine with my system (A4000/40, broken DMA, A2091/7.0
  99.     ROMs, Quantum LPS270S+LT730, Tandberg streamer) in conjunction with
  100.     MapBoard, however there may be problems with the serial port.
  101.  
  102. REQUIREMENTS
  103.  
  104.     vb2091 has been compiled with gcc, so it needs ixemul.library in libs:
  105.     and ENV: assigned. Keep this in mind when placing it in Your startup-
  106.     sequence. There will probably be a version that has been compiled with SAS
  107.     in this distribution. This version doesn't have these requirements.
  108.  
  109.     As it uses the exec-functions CopyMem()/CacheControl(), it doesn't work
  110.     with early versions of Kickstart (sorry, I don't know since when these
  111.     functions are present - probably since 2.0).
  112.     vb2091 does not check for a correct version at the moment (sorry).
  113.  
  114.     You must have some MEMF_24BITDMA RAM (e.g. RAM on the controller or
  115.     chipmem) to be used as a buffer.
  116.  
  117.     I hope I haven't forgotten anything (of course a controller and some
  118.     expansion RAM would be quite useful).
  119.  
  120.  
  121. USAGE
  122.  
  123.     [run] vb2091 UNIT <unitlist> [DEVICE <device>] [BUFSIZE <bufsize>]
  124.                  [MAXN <number>] [MIN1BUF <size>] [MIN2BUF <size>]
  125.                  [BROKEN] [SINGLE] [NOCACHE] [NOWRITE]
  126.  
  127.     All the keywords must be uppercase! (sorry)
  128.  
  129.     UNIT    List of unitnumbers of devices to be patched, not separated by
  130.             spaces or commas, e.g. 014 for device 0, 1 and 4.
  131.             (default: no default - this MUST be specified)
  132.  
  133.     DEVICE  Name of the device to be patched.
  134.             (default: 2nd.scsi.device)
  135.  
  136.     BUFSIZE Size of buffer in kilobytes.
  137.             (default: 256)
  138.  
  139.     BROKEN  Use this if You have got an A4000 that cannot DMA the chipmem.
  140.             You MUST have some 24Bit fastmem (e.g. on the controller)
  141.             then - vb2091 will only accept MEMF_FAST|MEMF_24BITDMA RAM
  142.             as buffer then.
  143.  
  144.     SINGLE  Normally vb2091 uses double-buffering to get slightly higher
  145.             transfer rates; use SINGLE, if free processor time is more
  146.             important to You. Currently only CMD_READ is double-buffered,
  147.             CMD_WRITE is not.
  148.  
  149.     NOWRITE If You specify this option, only CMD_READ ist patched, whereas
  150.             CMD_WRITE will be unchanged. Use this if You don't trust
  151.             vb2091.
  152.  
  153.     NOCACHE If this option is specified, the DataCache will be disabled
  154.             before CopyMem() and enabled after finishing; this will speedup
  155.             CopyMem() (at least on a 040). This has not been tested very
  156.             well, so be careful with this option.
  157.  
  158.     MAXN    <number> (default: 16)
  159.     MIN1BUF <size in kilobytes> (default: 128)
  160.     MIN2BUF <size in kilobytes> (default: 64)
  161.             These options can be used to adjust some parameters which are
  162.             used with double buffering. If a block of size l is to be read
  163.             then vb2091 will probably split the transfer into smaller blocks
  164.             for better use of double buffering. If l<MIN1BUF then vb2091
  165.             will use one transfer of l bytes (i.e. no double buffering), if
  166.             possible. If l>MAXN*MIN2BUF then the transfer will be split into
  167.             MAXN parts. If none of those conditions is true then the transfer
  168.             will be split into blocks of size MIN2BUF.
  169.             I thought about a rather simple method to let the user adjust the
  170.             buffers in different situations without having to specify one
  171.             BUFSIZE for almost every single transfer size. The method I used is
  172.             just heuristic and the default values were chosen rather arbitrary
  173.             and optimal values may be quite different (especially on different
  174.             systems). MIN2BUF shall be set to the smallest size which achieves
  175.             good transfer speeds with little cpu usage. So MIN2BUF is the value
  176.             which should usually be used as buffer size (yielding high rates
  177.             and as many chunks, i.e. best use of double buffering, as possible).
  178.             But if the transfer size is a little larger than MIN2BUF, it
  179.             wouldn't be a good idea to usee double buffering with those chunks.
  180.             E.g. with MIN2BUF=64k a 65k transfer would be split up in a 64k
  181.             transfer and a 1k transfer. Although I haven't tested it, one 65k
  182.             transfer should be better. Because of this You can prevent double
  183.             buffering for any transfers less than MIN1BUF. I set
  184.             MIN1BUF=2*MIN2BUF for default, but this may be too large.
  185.             Now if You have very large transfers (e.g. 4MB), then it would be
  186.             split up into 64 64k chunks. But from a certain number of chunks it
  187.             should be better not to raise the number of chunks but the size of
  188.             the chunks (especially as MIN2BUF should be set as small as
  189.             possible). This is what MAXN is for - however this is rather
  190.             theoretical, because I doubt that transfers that large will occur
  191.             often (if at all).
  192.             As said before this method can be argued (especially as I almost
  193.             haven't tested if my thoughts are true in reality) and the default
  194.             values may be far from optimal. So everybody who wants almost
  195.             optimal performance has to find out his personal values (they also
  196.             depend on the applications You use, because You can configure
  197.             vb2091 for best speed or least cpu usage or something inbetween).
  198.  
  199.  
  200.     Example:
  201.         run >NIL: vb2091 DEVICE scsi.device BUFSIZE 128 MAXN 8 UNIT 046
  202.  
  203.  
  204.     You can remove the patch by sending vb2091 a CTRL-C/break - but don't
  205.     do this while any program is using the device.
  206.  
  207.  
  208. SOURCE
  209.  
  210.     I decided to distribute the source in order to raise chances of finding
  211.     bugs. You should be able to compile it using gcc (I used 2.3.3) or SAS.
  212.     It is NOT meant to be an example of good programming and I am not liable
  213.     for anyone turning into stone after looking at it.
  214.  
  215.  
  216. CREDITS
  217.  
  218.     This program would not exist without the help of Olaf Seibert (another
  219.     poor fellow with a broken A4000) who encouraged me to write it and
  220.     provided me with helpful information. Thank You, Olaf!
  221.     Thomas Boerkel did the changes for SAS and compiled it.
  222.     Several testers helped to remove some bugs of the older versions and made
  223.     suggestions for improvement.
  224.  
  225. LEGAL
  226.  
  227.     vb2091 may be freely distributed as long as no part of the distribution
  228.     is changed.
  229.  
  230.     This program is Bearware: If You like it, You can send me something
  231.                               with a bear on it.
  232.  
  233.     But more important:
  234.  
  235.         If You try it, please send me Your experiences, bugreports,
  236.         suggestions etc.
  237.  
  238.  
  239.  
  240.  
  241. Volker Barthelmann
  242. Kennedy-Ring 39
  243. 91301 Forchheim
  244. Germany
  245.  
  246. I should be reachable per eMail via:
  247.  
  248. volker@vb.franken.de
  249.  
  250.  
  251. ============================= Archive contents =============================
  252.  
  253. Original  Packed Ratio    Date     Time    Name
  254. -------- ------- ----- --------- --------  -------------
  255.     3811    1234 67.6% 25-Jun-97 11:11:26  compiler.h
  256.      144      81 43.7% 25-Jun-97 11:11:24  smakefile
  257.      101      88 12.8% 25-Jun-97 11:11:24  smakefile.wth
  258.     9131    2497 72.6% 25-Jun-97 11:11:26  vb2091.c
  259.    15797    3942 75.0% 25-Jun-97 11:13:06  vbak2091.c
  260.    11011    4666 57.6% 25-Jun-97 11:22:24  vbak2091.readme
  261.      164     128 21.9% 25-Jun-97 11:31:26  scoptions
  262.     6276    3952 37.0% 25-Jun-97 11:31:34  vbak2091
  263.     4532    2761 39.0% 25-Jun-97 11:31:32  vbak2091.o
  264.     6216    3917 36.9% 25-Jun-97 11:31:16  vbak2091_020
  265.     6216    3917 36.9% 25-Jun-97 11:20:10  vbak2091_040
  266. -------- ------- ----- --------- --------
  267.    63399   27183 57.1% 27-Jun-97 00:24:08   11 files
  268.